<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pymsn.client.Client</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://telepathy.freedesktop.org/wiki/Pymsn">pymsn</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;pymsn ::
        <a href="pymsn.client-module.html">Module&nbsp;client</a> ::
        Class&nbsp;Client
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Client</h1><p class="nomargin-top"><span class="codelink"><a href="pymsn.client-pysrc.html#Client">source&nbsp;code</a></span></p>
<pre class="base-tree">
            object --+    
                     |    
<a href="pymsn.event.EventsDispatcher-class.html">event.EventsDispatcher</a> --+
                         |
                        <strong class="uidshort">Client</strong>
</pre>

<hr />
<p>This class provides way to connect to the notification server as well 
  as methods to manage the contact list, and the personnal settings.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.client.Client-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">server</span>,
        <span class="summary-sig-arg">proxies</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
        <span class="summary-sig-arg">transport_class</span>=<span class="summary-sig-default">&lt;class 'pymsn.transport.DirectConnection'&gt;</span>)</span><br />
      Initializer</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.client-pysrc.html#Client.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.client.Client-class.html#login" class="summary-sig-name">login</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">account</span>,
        <span class="summary-sig-arg">password</span>)</span><br />
      Login to the server.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.client-pysrc.html#Client.login">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="logout"></a><span class="summary-sig-name">logout</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Logout from the server.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.client-pysrc.html#Client.logout">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pymsn.event.EventsDispatcher-class.html">event.EventsDispatcher</a></code></b>:
      <code><a href="pymsn.event.EventsDispatcher-class.html#register_events_handler">register_events_handler</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="pymsn.event.client.ClientState-class.html" 
      class="link">pymsn.event.ClientState</a></span>
    </td><td class="summary">
        <a href="pymsn.client.Client-class.html#state" class="summary-name">state</a><br />
      The state of this Client
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="pymsn.profile.Profile-class.html" class="link">User</a></span>
    </td><td class="summary">
        <a href="pymsn.client.Client-class.html#profile" class="summary-name">profile</a><br />
      The profile of the current user
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code class="link">AddressBook</code></span>
    </td><td class="summary">
        <a href="pymsn.client.Client-class.html#address_book" class="summary-name">address_book</a><br />
      The address book of the current user
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="pymsn.p2p.MSNObjectStore-class.html" 
      class="link">MSNObjectStore</a></span>
    </td><td class="summary">
        <a href="pymsn.client.Client-class.html#msn_object_store" class="summary-name">msn_object_store</a><br />
      The MSNObjectStore instance associated with this client.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code class="link">OfflineIM</code></span>
    </td><td class="summary">
        <a href="pymsn.client.Client-class.html#oim_box" class="summary-name">oim_box</a><br />
      The offline IM for the current user
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code class="link">Spaces</code></span>
    </td><td class="summary">
        <a href="pymsn.client.Client-class.html#spaces" class="summary-name">spaces</a><br />
      The MSN Spaces of the current user
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">server</span>,
        <span class="sig-arg">proxies</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
        <span class="sig-arg">transport_class</span>=<span class="sig-default">&lt;class 'pymsn.transport.DirectConnection'&gt;</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.client-pysrc.html#Client.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initializer</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>server</code></strong> (tuple(host, port)) - the Notification server to connect to.</li>
        <li><strong class="pname"><code>proxies</code></strong> ({type: string =&gt; <code 
          class="link">gnet.proxy.ProxyInfos</code>}) - proxies that we can use to connect</li>
        <li><strong class="pname"><code>transport_class</code></strong> (<code class="link">pymsn.transport.AbstractTransport</code>) - the transport class to use for the network connection</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="login"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">login</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">account</span>,
        <span class="sig-arg">password</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.client-pysrc.html#Client.login">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Login to the server.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>account</code></strong> (utf-8 encoded string) - the account to use for authentication.</li>
        <li><strong class="pname"><code>password</code></strong> (utf-8 encoded string) - the password needed to authenticate to the account</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Property Details</span></td>
</tr>
</table>
<a name="state"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">state</h3>
  <p>The state of this Client</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.state(<span class="summary-sig-arg">self</span>)</span>
        - The state of this Client
    </dd>
    <dt>Type:</dt>
      <dd><a href="pymsn.event.client.ClientState-class.html" 
      class="link">pymsn.event.ClientState</a></dd>
  </dl>
</td></tr></table>
</div>
<a name="profile"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">profile</h3>
  <p>The profile of the current user</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.profile(<span class="summary-sig-arg">self</span>)</span>
        - The profile of the current user
    </dd>
    <dt>Type:</dt>
      <dd><a href="pymsn.profile.Profile-class.html" class="link">User</a></dd>
  </dl>
</td></tr></table>
</div>
<a name="address_book"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">address_book</h3>
  <p>The address book of the current user</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.address_book(<span class="summary-sig-arg">self</span>)</span>
        - The address book of the current user
    </dd>
    <dt>Type:</dt>
      <dd><code class="link">AddressBook</code></dd>
  </dl>
</td></tr></table>
</div>
<a name="msn_object_store"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">msn_object_store</h3>
  <p>The MSNObjectStore instance associated with this client.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.msn_object_store(<span class="summary-sig-arg">self</span>)</span>
        - The MSNObjectStore instance associated with this client.
    </dd>
    <dt>Type:</dt>
      <dd><a href="pymsn.p2p.MSNObjectStore-class.html" 
      class="link">MSNObjectStore</a></dd>
  </dl>
</td></tr></table>
</div>
<a name="oim_box"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">oim_box</h3>
  <p>The offline IM for the current user</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.oim_box(<span class="summary-sig-arg">self</span>)</span>
        - The offline IM for the current user
    </dd>
    <dt>Type:</dt>
      <dd><code class="link">OfflineIM</code></dd>
  </dl>
</td></tr></table>
</div>
<a name="spaces"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">spaces</h3>
  <p>The MSN Spaces of the current user</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.spaces(<span class="summary-sig-arg">self</span>)</span>
        - The MSN Spaces of the current user
    </dd>
    <dt>Type:</dt>
      <dd><code class="link">Spaces</code></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://telepathy.freedesktop.org/wiki/Pymsn">pymsn</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Aug  2 15:19:16 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
